<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Modify collection documents</title>
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-base.css" />
<link media="all" rel="stylesheet" type="text/css" href="styles/03e73060321a0a848018724a6c83de7f-theme-medium.css" />

 </head>
 <body class="docs"><div class="navbar navbar-fixed-top">
  <div class="navbar-inner clearfix">
    <ul class="nav" style="width: 100%">
      <li style="float: left;"><a href="mysql-xdevapi-collection.getsession.html">« Collection::getSession</a></li>
      <li style="float: right;"><a href="mysql-xdevapi-collection.remove.html">Collection::remove »</a></li>
    </ul>
  </div>
</div>
<div id="breadcrumbs" class="clearfix">
  <ul class="breadcrumbs-container">
    <li><a href="index.html">PHP Manual</a></li>
    <li><a href="class.mysql-xdevapi-collection.html">mysql_xdevapi\Collection</a></li>
    <li>Modify collection documents</li>
  </ul>
</div>
<div id="layout">
  <div id="layout-content"><div id="mysql-xdevapi-collection.modify" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Collection::modify</h1>
  <p class="verinfo">(No version information available, might only be in Git)</p><p class="refpurpose"><span class="refname">Collection::modify</span> &mdash; <span class="dc-title">Modify collection documents</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-mysql-xdevapi-collection.modify-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>mysql_xdevapi\Collection::modify</strong></span>(<span class="methodparam"><span class="type">string</span> <code class="parameter">$search_condition</code></span>): <span class="type"><a href="class.mysql-xdevapi-collectionmodify.html" class="type mysql_xdevapi\CollectionModify">mysql_xdevapi\CollectionModify</a></span></div>

  <p class="para rdfs-comment">
   Modify collections that meet specific search conditions. 
   Multiple operations are allowed, and parameter binding
   is supported.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-mysql-xdevapi-collection.modify-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt>
<code class="parameter">search_condition</code></dt>

    <dd>

     <p class="para">
      Must be a valid SQL expression used to match the documents to modify.
      This expression might be as simple as <strong><code>true</code></strong>, which matches all 
      documents, or it might use functions and operators such as 
      <code class="code">&#039;CAST(_id AS SIGNED) &gt;= 10&#039;</code>, 
      <code class="code">&#039;age MOD 2 = 0 OR age MOD 3 = 0&#039;</code>, or
      <code class="code">&#039;_id IN [&quot;2&quot;,&quot;5&quot;,&quot;7&quot;,&quot;10&quot;]&#039;</code>.
     </p>
    </dd>

   
  </dl>

 </div>


 <div class="refsect1 returnvalues" id="refsect1-mysql-xdevapi-collection.modify-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   If the operation is not executed, then the function will return 
   a Modify object that can be used to add additional
   modify operations.
  </p>
  <p class="para">
   If the modify operation is executed, then the returned object will contain
   the result of the operation.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-mysql-xdevapi-collection.modify-examples">
  <h3 class="title">范例</h3>
  <div class="example" id="example-1568">
   <p><strong>示例 #1 <span class="function"><strong>mysql_xdevapi\Collection::modify()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br />$session&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">mysql_xdevapi</span><span style="color: #007700">\</span><span style="color: #0000BB">getSession</span><span style="color: #007700">(</span><span style="color: #DD0000">"mysqlx://user:password@localhost"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"DROP&nbsp;DATABASE&nbsp;IF&nbsp;EXISTS&nbsp;addressbook"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">sql</span><span style="color: #007700">(</span><span style="color: #DD0000">"CREATE&nbsp;DATABASE&nbsp;addressbook"</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #0000BB">$schema&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getSchema</span><span style="color: #007700">(</span><span style="color: #DD0000">"addressbook"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$collection&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$schema</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">createCollection</span><span style="color: #007700">(</span><span style="color: #DD0000">"people"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name":&nbsp;"Alfred",&nbsp;"age":&nbsp;18,&nbsp;"job":&nbsp;"Butler"}'</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$collection</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">'{"name":&nbsp;"Bob",&nbsp;&nbsp;&nbsp;&nbsp;"age":&nbsp;19,&nbsp;"job":&nbsp;"Painter"}'</span><span style="color: #007700">)-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">//&nbsp;Add&nbsp;two&nbsp;new&nbsp;jobs&nbsp;for&nbsp;all&nbsp;Painters:&nbsp;Artist&nbsp;and&nbsp;Crafter<br /></span><span style="color: #0000BB">$collection<br />&nbsp;&nbsp;</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">modify</span><span style="color: #007700">(</span><span style="color: #DD0000">"job&nbsp;in&nbsp;('Butler',&nbsp;'Painter')"</span><span style="color: #007700">)<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">arrayAppend</span><span style="color: #007700">(</span><span style="color: #DD0000">'job'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'Artist'</span><span style="color: #007700">)<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">arrayAppend</span><span style="color: #007700">(</span><span style="color: #DD0000">'job'</span><span style="color: #007700">,&nbsp;</span><span style="color: #DD0000">'Crafter'</span><span style="color: #007700">)<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">//&nbsp;Remove&nbsp;the&nbsp;'beer'&nbsp;field&nbsp;from&nbsp;all&nbsp;documents&nbsp;with&nbsp;the&nbsp;age&nbsp;21<br /></span><span style="color: #0000BB">$collection<br />&nbsp;&nbsp;</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">modify</span><span style="color: #007700">(</span><span style="color: #DD0000">'age&nbsp;&lt;&nbsp;21'</span><span style="color: #007700">)<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">unset</span><span style="color: #007700">([</span><span style="color: #DD0000">'beer'</span><span style="color: #007700">])<br />&nbsp;&nbsp;-&gt;</span><span style="color: #0000BB">execute</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

  </div>
 </div>


</div></div></div></body></html>